DOCS-3472: Add documentation for Viam Apps #4335
Conversation
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
👋 Thanks for contributing! A reviewer will look at it on the next working day! |
npentrel
changed the title
npentrel
force-pushed
the
docs-update-a3ce53e9-1afa-4e47-8e40-7a3998fb4c11-20250521-113348
branch
4 times, most recently
from
d89e2d9 to
dd2973a
Compare
There was a problem hiding this comment.
Haven't looked at this yet - do not review yet
npentrel
force-pushed
the
docs-update-a3ce53e9-1afa-4e47-8e40-7a3998fb4c11-20250521-113348
branch
from
dd2973a to
02c4c41
Compare
|
@bashar-515 would you mind reviewing just https://deploy-preview-4335--viam-docs.netlify.app/operate/control/single-page-apps/ this is the file: https://github.com/viamrobotics/docs/pull/4335/files#diff-1385fdec2acd1b00756a9f8d97d02712493ecd5909edc99b6db7cb4259c85a70 ? The rest isn't quite finished yet |
npentrel
force-pushed
the
docs-update-a3ce53e9-1afa-4e47-8e40-7a3998fb4c11-20250521-113348
branch
2 times, most recently
from
11f6861 to
6b62ff7
Compare
There was a problem hiding this comment.
Unrelated but doesn't hurt to keep it here
npentrel
force-pushed
the
docs-update-a3ce53e9-1afa-4e47-8e40-7a3998fb4c11-20250521-113348
branch
from
03ef06e to
e226798
Compare
|
I have moved the tutorial update to #4340. This PR is ready for review |
npentrel
force-pushed
the
docs-update-a3ce53e9-1afa-4e47-8e40-7a3998fb4c11-20250521-113348
branch
5 times, most recently
from
412fb4a to
c12df67
Compare
npentrel
changed the title
docs/operate/control/viam-app.md
Outdated
| weight: 5 | ||
| layout: "docs" | ||
| type: "docs" | ||
| description: "Create and deploy custom web interfaces for your machines as single-page applications without managing hosting and authentication." |
There was a problem hiding this comment.
Discussed on Slack- I think we should remove any mention of "single-page"
docs/operate/control/viam-app.md
Outdated
|
|
||
| ### Access machines from your app | ||
|
|
||
| Viam apps provide access to a machine by placing its API key in your local storage. |
There was a problem hiding this comment.
The API Key ends up getting stored as a cookie, not in localStorage or sessionStorage.
docs/operate/control/viam-app.md
Outdated
| } = JSON.parse(Cookies.get(machineId)!)); | ||
| ``` | ||
|
|
||
| For developing your app on localhost, add the same information to your browsers local storage. |
There was a problem hiding this comment.
This is getting removed, right? If so, we'll make sure to ping you when this ticket is done so this doc can be updated.
There was a problem hiding this comment.
yeah, we won't publish until that ticket is ready. I just thought we were more eager to get this live than we apparently are
docs/operate/control/viam-app.md
Outdated
| <!-- prettier-ignore --> | ||
| | Property | Type | Description | | ||
| | ------------ | ------ | ----------- | | ||
| | `name` | string | The name of your application, which will be a part of the app's URL (`name_publicnamespace.viamapplications.com`). For more information on valid names see [](/operate/reference/naming-modules/#valid-application-identifiers). | |
There was a problem hiding this comment.
This didn't render anything for me in the preview.
|
|
||
| ## FAQ | ||
|
|
||
| ### Can I use a custom domain? |
There was a problem hiding this comment.
@NickPPC can you re-review this part?
|
|
||
| ## FAQ | ||
|
|
||
| ### Can I use a custom domain? |
npentrel
force-pushed
the
docs-update-a3ce53e9-1afa-4e47-8e40-7a3998fb4c11-20250521-113348
branch
from
37312f9 to
4ea5250
Compare
Co-authored-by: Nicolas Palpacuer <[email protected]>
Co-authored-by: Nicolas Palpacuer <[email protected]>
npentrel
force-pushed
the
docs-update-a3ce53e9-1afa-4e47-8e40-7a3998fb4c11-20250521-113348
branch
from
2e76007 to
50b6524
Compare
npentrel
force-pushed
the
docs-update-a3ce53e9-1afa-4e47-8e40-7a3998fb4c11-20250521-113348
branch
from
50b6524 to
fae3a6e
Compare
| } = JSON.parse(Cookies.get(machineCookieKey)!)); | ||
| ``` | ||
|
|
||
| For developing your application on localhost, run the following command which will proxy your local app. |
There was a problem hiding this comment.
I think we should explicitly say that the user's app that they've developed should also have its own server running on its own port in addition to this server being spun up by the Viam CLI and that this is what --app-ul is referring to; that was a key step that I (and @ohEmily) missed when testing this ourselves. Also, a "local development" header/subsection title might be nice?
Co-authored-by: Nicolas Palpacuer <[email protected]>
npentrel
force-pushed
the
docs-update-a3ce53e9-1afa-4e47-8e40-7a3998fb4c11-20250521-113348
branch
from
8f6c9f2 to
c95668c
Compare
npentrel
deleted the
docs-update-a3ce53e9-1afa-4e47-8e40-7a3998fb4c11-20250521-113348
branch
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs' |
Main changes are here: https://deploy-preview-4335--viam-docs.netlify.app/operate/control/viam-applications/
TODO:
Created comprehensive documentation for the new Viam Single Page Apps feature (APP-7529) that allows users to upload single page applications and access them via appname.publicnamespace.viamapps.com with hosting, authentication, and boilerplate logic handled by Viam. Added a main reference page, updated module configuration and naming documentation.